Skip to main content

Get Similar Entries API

Overview​

This API endpoint retrieves similar entries to a given entry. Similarity is calculated based on the L2 distance of selected fields in a source (is indexed is set to true). Before calling this endpoint, you must have built a similary index beforehand.

Endpoint​

GET https://api.myboardtoday.com/app/:app_id/source/:source_id/entry/:entry_id/similar

Path Parameters​

  • app_id (required): The unique identifier (uuid) of the app.
  • source_id (required): The unique identifier (uuid) of the source.
  • entry_id (required): The unique identifier (uuid) of the entry.

Query Parameters​

  • k (optional, integer, default 5): The top k result to return

Headers​

  • x-api-key (required): The API key for authentication.

Return Value​

A JSON object like:

{
    "distance": [5, 4, 3, 2, 1]
    "similar_items": ["uuid1", "uuid2", "uuid3", "uudi4", "uuid5"]
}

Report Bugs, Request New Features, and Win $50 Every Month

We value your precious feedback. Please contact us when you find a bug or would like to request a new feature. (In the main panel, click on the bob logo on the top left corner, then in the Dropdown menu click on “contact for bugs or new features”). Every month we will select an “opinion leader” and reward him/her with $50 in cash.